home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / cat.1 / xmcd.1 < prev    next >
Text File  |  1995-07-25  |  22KB  |  463 lines

  1.  
  2.  
  3.  
  4.      XXXXMMMMCCCCDDDD((((1111))))                vvvv1111....1111 ((((11114444 JJJJaaaannnn 1111999999994444))))                 XXXXMMMMCCCCDDDD((((1111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           xmcd - CD digital audio player utility for X11/Motif
  10.  
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           xxxxmmmmccccdddd [_t_o_o_l_k_i_t_o_p_t_i_o_n ...] [-_d_e_v _d_e_v_i_c_e] [-_d_b_d_i_r _p_a_t_h] [-
  14.           _d_e_b_u_g]
  15.  
  16.  
  17.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.           _X_m_c_d is a program that allows the use of the CD-ROM drive as
  19.           a full-featured stereo compact-disc player for the X window
  20.           system.
  21.  
  22.           Most of the features found on real CD players are available
  23.           in _x_m_c_d, such as shuffle and repeat, track programming
  24.           functions, and a numeric keypad for direct track access.
  25.           Additional functions include sample play, A to B segment
  26.           play, volume control, etc.
  27.  
  28.           A built-in CD database feature allows the CD artist/title
  29.           and track titles, and other associated general purpose text
  30.           to be maintained and loaded as the program is started or
  31.           when a CD is inserted.
  32.  
  33.           Full feature-specific pop-up help is available for all
  34.           controls, indicators, text input fields, and lists.
  35.  
  36.           On systems with more than one CD-ROM drive, multiple
  37.           invocations of _x_m_c_d can be used to operate each drive
  38.           independently.
  39.  
  40.           _X_m_c_d is designed to be easy to use, as the main window is
  41.           purposely made to resemble a real CD player front panel.
  42.           All other pop-up windows are also designed to be as
  43.           intuitive as possible.  Moreover, while the use of a mouse
  44.           is natural with _x_m_c_d, all functionality can also be operated
  45.           via the keyboard.  This is in conformance to the guidelines
  46.           published in the _O_S_F/_M_o_t_i_f _S_t_y_l_e _G_u_i_d_e from the Open
  47.           Software Foundation.
  48.  
  49.           The internal architecture of _x_m_c_d is designed from the start
  50.           to be easily portable to many operating system platforms,
  51.           and adaptable to the myriad of CD-ROM drives available.
  52.  
  53.  
  54.      OOOOPPPPTTTTIIIIOOOONNNNSSSS
  55.           All standard _X_t _I_n_t_r_i_n_s_i_c_s toolkit options are supported.
  56.           In addition, _x_m_c_d supports the following options:
  57.  
  58.           -_d_e_v _d_e_v_i_c_e
  59.                Specifies the path name to the raw CD-ROM device.  If
  60.  
  61.  
  62.  
  63.      Page 1                                           (printed 7/3/94)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXMMMMCCCCDDDD((((1111))))                vvvv1111....1111 ((((11114444 JJJJaaaannnn 1111999999994444))))                 XXXXMMMMCCCCDDDD((((1111))))
  71.  
  72.  
  73.  
  74.                this option is not used, the default device to be used
  75.                is the first drive set up with the _x_m_c_d configuration
  76.                program (See below).
  77.  
  78.           -_d_b_d_i_r _l_i_s_t
  79.                Specifies a colon-separated list of category
  80.                directories where the CD database files are to be kept.
  81.                See the description for XXXXMMMMCCCCDDDD____DDDDBBBBPPPPAAAATTTTHHHH in the ENVIRONMENT
  82.                section below.
  83.  
  84.           -_d_e_b_u_g
  85.                Causes verbose debugging diagnostics to be printed on
  86.                _s_t_d_e_r_r.
  87.  
  88.  
  89.      XXXX RRRREEEESSSSOOOOUUUURRRRCCCCEEEESSSS
  90.           _X_m_c_d has many adjustable X resources to customize its look
  91.           and feel, as well as its behavior.  Notably, the colors of
  92.           virtually every feature on _x_m_c_d's windows can be changed, as
  93.           well as the text fonts.  All text labels can also be changed
  94.           (for example, to another language).
  95.  
  96.           There are too many resources to list here, but the resource
  97.           names and their defaults (plus descriptive comments) can be
  98.           found in the LLLLIIIIBBBBDDDDIIIIRRRR/_a_p_p-_d_e_f_a_u_l_t_s/_X_M_c_d file (where LIBDIR is
  99.           typically /_u_s_r/_l_i_b/_X_1_1).  It is not recommended that you
  100.           change values in the LLLLIIIIBBBBDDDDIIIIRRRR/_a_p_p-_d_e_f_a_u_l_t_s/_X_M_c_d file, unless
  101.           you want the changes to be forced upon all users of _x_m_c_d on
  102.           the system.  Instead, make a copy of this file, change the
  103.           copy as you see fit, then place it in your home directory.
  104.           Your custom resource settings will then override the
  105.           defaults when _x_m_c_d is subsequently started.  Alternatively,
  106.           you may also place specific resources you wish to override
  107.           in the ._X_d_e_f_a_u_l_t_s file in your home directory.
  108.  
  109.  
  110.      DDDDEEEEVVVVIIIICCCCEEEE CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN
  111.           The X resources described in the previous section affect the
  112.           general appearance and behavior of _x_m_c_d. There are
  113.           additional configurable parameters that must vary on a per-
  114.           drive basis.  For example, in some cases _x_m_c_d must operate
  115.           the drive differently depending upon the brand and model of
  116.           the drive.  Thus, there must be a separate configuration
  117.           file for these parameters _p_e_r-_d_e_v_i_c_e.  The default file is
  118.           XXXXMMMMCCCCDDDDLLLLIIIIBBBB/_c_o_n_f_i_g/DDDDEEEEVVVVIIIICCCCEEEE (where XMCDLIB is typically
  119.           /_u_s_r/_l_i_b/_X_1_1/_x_m_c_d and DEVICE is the base name of the raw
  120.           device special file for the CD-ROM drive ; e.g.,
  121.           /_u_s_r/_l_i_b/_X_1_1/_x_m_c_d/_c_o_n_f_i_g/_r_c_d_0).  A configuration program
  122.           XXXXMMMMCCCCDDDDLLLLIIIIBBBB/_c_o_n_f_i_g/_c_o_n_f_i_g_u_r_e._s_h is provided to make maintaining
  123.           the device-specific configuration file easy (Note: on SCO
  124.           systems the configuration program can also be invoked as
  125.           "_m_k_d_e_v _x_m_c_d").
  126.  
  127.  
  128.  
  129.      Page 2                                           (printed 7/3/94)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXMMMMCCCCDDDD((((1111))))                vvvv1111....1111 ((((11114444 JJJJaaaannnn 1111999999994444))))                 XXXXMMMMCCCCDDDD((((1111))))
  137.  
  138.  
  139.  
  140.           You should always use the configuration program to set the
  141.           device-specific parameters when installing _x_m_c_d for the
  142.           first time, or when the CD-ROM hardware configuration has
  143.           changed.  If this is not done then _x_m_c_d will probably not
  144.           operate correctly with your CD-ROM drive.
  145.  
  146.           WWWWAAAARRRRNNNNIIIINNNNGGGG:::: If _x_m_c_d is not correctly configured, you may cause
  147.           _x_m_c_d to deliver commands that are not supported by your CD-
  148.           ROM drive.  Under some environments this may lead to system
  149.           hang or crash.
  150.  
  151.           You can override some of the device-specific configuration
  152.           parameters by adding your own configuration files.  _X_m_c_d
  153.           will also look in HHHHOOOOMMMMEEEE/._x_m_c_d_c_f_g/DDDDEEEEVVVVIIIICCCCEEEE file for device-
  154.           specific parameters (where HOME is your home directory and
  155.           DEVICE is as specified above).  Parameters found in this
  156.           file will override the system defaults (except those
  157.           parameters that cannot be overridden; see the comments in
  158.           the XXXXMMMMCCCCDDDDLLLLIIIIBBBB/_c_o_n_f_i_g/_d_e_v._c_o_n_f_i_g for details).
  159.  
  160.  
  161.      UUUUSSSSIIIINNNNGGGG XXXXMMMMCCCCDDDD
  162.           The basic functions of _x_m_c_d are designed to operate the same
  163.           way as on a real stereo CD player.  The pictorial symbols
  164.           used on the main window buttons are intended to illustrate
  165.           the function in a non-language-specific manner.  You can
  166.           also change all main window buttons to display a text label
  167.           instead of the pictorial symbols, by clicking the ddddiiiissssppppllllaaaayyyy
  168.           check-box button (the "A" symbol enclosed in a box) located
  169.           at the upper left hand corner of the main window.
  170.  
  171.           The CD database and track programming functions are operated
  172.           via the CD Database/Track Program Editor pop-up subwindow.
  173.           You activate the subwindow by pressing the ccccddddddddbbbb////pppprrrroooogggg button
  174.           (file cabinet symbol) on the main window (See "CD DATABASE"
  175.           below).
  176.  
  177.           There will not be a per-item description of all the
  178.           features, because full on-line help is available (See
  179.           "ONLINE HELP" below).
  180.  
  181.  
  182.      OOOONNNNLLLLIIIINNNNEEEE HHHHEEEELLLLPPPP
  183.           For general information about _x_m_c_d, click the hhhheeeellllpppp (question
  184.           mark symbol) button on the _x_m_c_d main window.  You can also
  185.           get specific help information about each button, control,
  186.           indicator, text entry area, selection list by positioning
  187.           the mouse cursor over the desired item, then clicking the
  188.           third mouse button.  A pop-up window will appear, containing
  189.           the relevant help text.
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                           (printed 7/3/94)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXMMMMCCCCDDDD((((1111))))                vvvv1111....1111 ((((11114444 JJJJaaaannnn 1111999999994444))))                 XXXXMMMMCCCCDDDD((((1111))))
  203.  
  204.  
  205.  
  206.      TTTTRRRRAAAACCCCKKKK PPPPRRRROOOOGGGGRRRRAAAAMMMMMMMMIIIINNNNGGGG
  207.           You can program _x_m_c_d to play only certain tracks, in a
  208.           custom sequence.  To do so, invoke the CD Database window
  209.           (by pressing the ccccddddddddbbbb////pppprrrroooogggg button on the main window).
  210.           Select the desired track by clicking on the entry in the
  211.           TTTTrrrraaaacccckkkk lllliiiisssstttt,,,, and click the AAAAdddddddd button to add to the play
  212.           sequence.  Notice that the track number appears in the PPPPllllaaaayyyy
  213.           sssseeeeqqqquuuueeeennnncccceeee text field.  You can also type the track numbers,
  214.           separated with commas, directly in the PPPPllllaaaayyyy sssseeeeqqqquuuueeeennnncccceeee field.
  215.           Repeat until all desired tracks have been entered, then
  216.           press the Track Program PPPPllllaaaayyyy button in the CD Database
  217.           window (not the PPPPllllaaaayyyy////PPPPaaaauuuusssseeee button on the main window) to
  218.           start the program play.
  219.  
  220.           During program play, the pppprrrroooogggg indicator in the main window
  221.           display area "illuminates".
  222.  
  223.  
  224.      CCCCDDDD DDDDAAAATTTTAAAABBBBAAAASSSSEEEE
  225.           The CD Database feature of _x_m_c_d allows you to enter the CD
  226.           artist/title, track titles, other free-form text (such as
  227.           band information, lyrics, etc.) associated with the disc and
  228.           tracks, and a track play program.  After this information is
  229.           typed in and saved to a database file, it will automatically
  230.           appear on the _x_m_c_d CD Database window when the same CD is
  231.           inserted again.
  232.  
  233.           You must perform a "save" operation (press the SSSSaaaavvvveeee button)
  234.           after typing in the database information before ejecting the
  235.           CD or exiting, or the information will be lost.  If this is
  236.           the first time this CD database entry is being stored, you
  237.           will be asked to select a category (rock, classical, jazz,
  238.           etc.) under which to classify the CD.  The category is used
  239.           by _x_m_c_d to determine the actual directory in the filesystem
  240.           to write the database file.
  241.  
  242.           Once the database information has been saved, the ccccddddddddbbbb
  243.           indicator on the _x_m_c_d main window display area
  244.           "illuminates".
  245.  
  246.           You must type the CD information into the database because
  247.           the CD's table of contents (TOC) contains only the number of
  248.           tracks and the starting address of each track, but not the
  249.           actual disc and track titles.
  250.  
  251.           The CD database window should prove to be intuitive to use.
  252.           You may use the on-line help system to obtain specific help
  253.           information about the various buttons and items.
  254.  
  255.           The CD database information is stored in text files, one per
  256.           CD, in a designated directory (category).  The path of this
  257.           directory is XXXXMMMMCCCCDDDDLLLLIIIIBBBB/_c_d_d_b/CCCCAAAATTTTEEEEGGGGOOOORRRRYYYY, where XMCDLIB is the
  258.  
  259.  
  260.  
  261.      Page 4                                           (printed 7/3/94)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      XXXXMMMMCCCCDDDD((((1111))))                vvvv1111....1111 ((((11114444 JJJJaaaannnn 1111999999994444))))                 XXXXMMMMCCCCDDDD((((1111))))
  269.  
  270.  
  271.  
  272.           directory specified by the XMcd.libdir resource, and
  273.           CATEGORY is the category name selected when SSSSaaaavvvveeee is
  274.           performed.  The list of categories used is specified by the
  275.           XMcd.dbdir resource.  In addition, if the XMcd.dbdir
  276.           resource contains full directory path names, then these will
  277.           be used without prefixing the XXXXMMMMCCCCDDDDLLLLIIIIBBBB/_c_d_d_b.
  278.  
  279.           You may view the list of directories that _x_m_c_d will search
  280.           for CD database files by pressing the AAAAbbbboooouuuutttt............ button and
  281.           viewing the pop-up information window.
  282.  
  283.           The file name of each CD database entry is a hexadecimal
  284.           representation of a special "magic" number computed by _x_m_c_d
  285.           based on the number of tracks, track timings, and other
  286.           available information about this CD.  This method is used
  287.           because there is no reliable unique CD identifier to be
  288.           found on the CD itself (the CD standard allows for a
  289.           readable IPC/barcode but very few CDs actually contain such
  290.           information).
  291.  
  292.           Since different pressings of the same CD may sometimes
  293.           contain slightly different track timings, the resultant
  294.           magic number computed by _x_m_c_d on these CDs will be
  295.           different.  Thus, if you load a CD that is not the same one
  296.           that a CD database entry was created with (but is actually
  297.           the same CD title), _x_m_c_d may not recognize it and display
  298.           the database information automatically when you insert the
  299.           CD.  In this event, you can search the CD database and find
  300.           the appropriate entry, and establish a "link" to it.  To do
  301.           so, press the LLLLiiiinnnnkkkk button, and select the appropriate
  302.           category on the popup window.  _X_m_c_d will then present
  303.           another pop-up window containing a list of all CD database
  304.           entries in the specified category (that has the same number
  305.           of tracks as the currently inserted disc).  Select the
  306.           appropriate entry and a link will be made in the CD
  307.           database.
  308.  
  309.           The LLLLiiiinnnnkkkk feature alleviates the need to type in CD database
  310.           information again and avoids duplicate CD database entries.
  311.  
  312.           In very rare occasions it is possible that the magic number
  313.           of a CD conflicts with that of another.  This is a problem
  314.           that will be addressed in a future release of _x_m_c_d.
  315.  
  316.  
  317.      EEEENNNNVVVVIIIIRRRROOOONNNNMMMMEEEENNNNTTTT
  318.           Several environment variables are currently recognized by
  319.           _x_m_c_d, and are described as follows:
  320.  
  321.           XXXXMMMMCCCCDDDD____LLLLIIIIBBBBDDDDIIIIRRRR
  322.                This is used to override the XMcd.libdir resource.
  323.                This parameter is the directory path under which _x_m_c_d'_s
  324.  
  325.  
  326.  
  327.      Page 5                                           (printed 7/3/94)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      XXXXMMMMCCCCDDDD((((1111))))                vvvv1111....1111 ((((11114444 JJJJaaaannnn 1111999999994444))))                 XXXXMMMMCCCCDDDD((((1111))))
  335.  
  336.  
  337.  
  338.                configuration files, help files, and CD database files
  339.                are located.  The default value of XMCD_LIBDIR on most
  340.                systems is /_u_s_r/_l_i_b/_X_1_1/_x_m_c_d.
  341.  
  342.           XXXXMMMMCCCCDDDD____DDDDBBBBPPPPAAAATTTTHHHH
  343.                This is used to override the XMcd.dbdir resource, which
  344.                is a list of CD database category directories to be
  345.                used under XXXXMMMMCCCCDDDDLLLLIIIIBBBB/_c_d_d_b (where XMCDLIB is the directory
  346.                root specified by the XMcd.libdir resource or the
  347.                XMCD_LIBDIR environment variable).  You may also use
  348.                the ----ddddbbbbddddiiiirrrr command line option, which has the highest
  349.                precedence.  An example of a XMCD_DBPATH string is as
  350.                follows (note the colon separators):
  351.  
  352.                    rrrroooocccckkkk::::ccccllllaaaassssssssiiiiccccaaaallll::::jjjjaaaazzzzzzzz::::nnnneeeewwwwaaaaggggeeee::::ssssoooouuuunnnnddddttttrrrraaaacccckkkk::::mmmmiiiisssscccc
  353.  
  354.                This string will cause _x_m_c_d to search the following
  355.                directories for CD database files:
  356.  
  357.                    XXXXMMMMCCCCDDDDLLLLIIIIBBBB/_c_d_d_b/_r_o_c_k
  358.                    XXXXMMMMCCCCDDDDLLLLIIIIBBBB/_c_d_d_b/_c_l_a_s_s_i_c_a_l
  359.                    XXXXMMMMCCCCDDDDLLLLIIIIBBBB/_c_d_d_b/_j_a_z_z
  360.                    etc.
  361.  
  362.                You may also specify absolute path names in the
  363.                XMCD_DBPATH entries.  Example:
  364.  
  365.                    rrrroooocccckkkk::::ccccllllaaaassssssssiiiiccccaaaallll::::////uuuussssrrrr////jjjjoooohhhhnnnn////iiiinnnndddduuuussssttttrrrriiiiaaaallll::::////uuuussssrrrr////jjjjoooohhhhnnnn////tttteeeecccchhhhnnnnoooo
  366.  
  367.           HHHHOOOOMMMMEEEE This is used to determine your home directory.  If HOME
  368.                is not defined, then _x_m_c_d tries to obtain it from the
  369.                /_e_t_c/_p_a_s_s_w_d file.  The home directory path is used by
  370.                _x_m_c_d to locate the ._x_m_c_d_c_f_g directory.
  371.  
  372.  
  373.      NNNNOOOOTTTTEEEESSSS
  374.           Not all CD-ROM drives support all features that appear on
  375.           _x_m_c_d. For example, most SCSI-1 drives do not support a
  376.           software-driven volume control.  On these drives the _x_m_c_d
  377.           volume control slider may have no effect, or in some cases
  378.           it is made to function as a mute control (i.e., it will snap
  379.           to the full-off or full-on positions only).  Similarly, the
  380.           ccccaaaaddddddddyyyy lllloooocccckkkk, eeeejjjjeeeecccctttt and iiiinnnnddddeeeexxxx sssseeeeaaaarrrrcccchhhh buttons found on _x_m_c_d may
  381.           not have any effect on drives that do not support the
  382.           appropriate functionality.
  383.  
  384.  
  385.      FFFFIIIILLLLEEEESSSS
  386.           $HOME/.xmcdcfg/*
  387.           XMCDLIB/cddb/*
  388.           XMCDLIB/config/configure.sh
  389.           XMCDLIB/config/dev.config
  390.  
  391.  
  392.  
  393.      Page 6                                           (printed 7/3/94)
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.      XXXXMMMMCCCCDDDD((((1111))))                vvvv1111....1111 ((((11114444 JJJJaaaannnn 1111999999994444))))                 XXXXMMMMCCCCDDDD((((1111))))
  401.  
  402.  
  403.  
  404.           XMCDLIB/config/.tbl/*
  405.           XMCDLIB/config/*
  406.           XMCDLIB/help/*
  407.           LIBDIR/app-defaults/XMcd
  408.           BINDIR/xmcd
  409.           MANDIR/xmcd.1
  410.  
  411.  
  412.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  413.           wm2xmcd(1), X(1).
  414.  
  415.  
  416.      AAAAUUUUTTTTHHHHOOOORRRR
  417.           Ti Kan (_t_i@_a_m_b._o_r_g)
  418.           AMB Research Laboratories, Sunnyvale, CA, U.S.A.
  419.  
  420.           _X_m_c_d also contains code contributed by several dedicated
  421.           individuals.  See the README file in the _x_m_c_d distribution
  422.           for information.
  423.  
  424.           Comments, suggestions, and bug reports are always welcome.
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.      Page 7                                           (printed 7/3/94)
  460.  
  461.  
  462.  
  463.